<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>filewriter.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_fs_filewriter.js.html">filewriter.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2011 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview A wrapper for the HTML5 FileWriter object.
<a name="line17"></a> *
<a name="line18"></a> * When adding or modifying functionality in this namespace, be sure to update
<a name="line19"></a> * the mock counterparts in goog.testing.fs.
<a name="line20"></a> *
<a name="line21"></a> */
<a name="line22"></a>
<a name="line23"></a>goog.provide(&#39;goog.fs.FileWriter&#39;);
<a name="line24"></a>
<a name="line25"></a>goog.require(&#39;goog.fs.Error&#39;);
<a name="line26"></a>goog.require(&#39;goog.fs.FileSaver&#39;);
<a name="line27"></a>
<a name="line28"></a>
<a name="line29"></a>
<a name="line30"></a>/**
<a name="line31"></a> * An object for monitoring the saving of files, as well as other fine-grained
<a name="line32"></a> * writing operations.
<a name="line33"></a> *
<a name="line34"></a> * This should not be instantiated directly. Instead, it should be accessed via
<a name="line35"></a> * {@link goog.fs.FileEntry#createWriter}.
<a name="line36"></a> *
<a name="line37"></a> * @param {!FileWriter} writer The underlying FileWriter object.
<a name="line38"></a> * @constructor
<a name="line39"></a> * @extends {goog.fs.FileSaver}
<a name="line40"></a> */
<a name="line41"></a>goog.fs.FileWriter = function(writer) {
<a name="line42"></a>  goog.base(this, writer);
<a name="line43"></a>
<a name="line44"></a>  /**
<a name="line45"></a>   * The underlying FileWriter object.
<a name="line46"></a>   *
<a name="line47"></a>   * @type {!FileWriter}
<a name="line48"></a>   * @private
<a name="line49"></a>   */
<a name="line50"></a>  this.writer_ = writer;
<a name="line51"></a>};
<a name="line52"></a>goog.inherits(goog.fs.FileWriter, goog.fs.FileSaver);
<a name="line53"></a>
<a name="line54"></a>
<a name="line55"></a>/**
<a name="line56"></a> * @return {number} The byte offset at which the next write will occur.
<a name="line57"></a> */
<a name="line58"></a>goog.fs.FileWriter.prototype.getPosition = function() {
<a name="line59"></a>  return this.writer_.position;
<a name="line60"></a>};
<a name="line61"></a>
<a name="line62"></a>
<a name="line63"></a>/**
<a name="line64"></a> * @return {number} The length of the file.
<a name="line65"></a> */
<a name="line66"></a>goog.fs.FileWriter.prototype.getLength = function() {
<a name="line67"></a>  return this.writer_.length;
<a name="line68"></a>};
<a name="line69"></a>
<a name="line70"></a>
<a name="line71"></a>/**
<a name="line72"></a> * Write data to the file.
<a name="line73"></a> *
<a name="line74"></a> * @param {!Blob} blob The data to write.
<a name="line75"></a> */
<a name="line76"></a>goog.fs.FileWriter.prototype.write = function(blob) {
<a name="line77"></a>  try {
<a name="line78"></a>    this.writer_.write(blob);
<a name="line79"></a>  } catch (e) {
<a name="line80"></a>    throw new goog.fs.Error(e.code, &#39;writing file&#39;);
<a name="line81"></a>  }
<a name="line82"></a>};
<a name="line83"></a>
<a name="line84"></a>
<a name="line85"></a>/**
<a name="line86"></a> * Set the file position at which the next write will occur.
<a name="line87"></a> *
<a name="line88"></a> * @param {number} offset An absolute byte offset into the file.
<a name="line89"></a> */
<a name="line90"></a>goog.fs.FileWriter.prototype.seek = function(offset) {
<a name="line91"></a>  try {
<a name="line92"></a>    this.writer_.seek(offset);
<a name="line93"></a>  } catch (e) {
<a name="line94"></a>    throw new goog.fs.Error(e.code, &#39;seeking in file&#39;);
<a name="line95"></a>  }
<a name="line96"></a>};
<a name="line97"></a>
<a name="line98"></a>
<a name="line99"></a>/**
<a name="line100"></a> * Changes the length of the file to that specified.
<a name="line101"></a> *
<a name="line102"></a> * @param {number} size The new size of the file, in bytes.
<a name="line103"></a> */
<a name="line104"></a>goog.fs.FileWriter.prototype.truncate = function(size) {
<a name="line105"></a>  try {
<a name="line106"></a>    this.writer_.truncate(size);
<a name="line107"></a>  } catch (e) {
<a name="line108"></a>    throw new goog.fs.Error(e.code, &#39;truncating file&#39;);
<a name="line109"></a>  }
<a name="line110"></a>};
</pre>


</body>
</html>
